home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / archive / userbox / publicdomain / htmless.lha / HTMLess / HTMLess.doc < prev    next >
Text File  |  1996-07-25  |  14KB  |  382 lines
  1. *****************************************
  2. *        `HTMLess'  v2.1        *
  3. *       An OriginalWare release by      *
  4. *        Troglobyte/Darkness        *
  5. *****************************************
  6. $VER:HTMLess.doc v2.1 23.Jul.96 Troglobyte/Darkness
  7.  
  8. Contents
  9. ========
  10.  
  11. 1. Introduction
  12. 2. Workbench usage and ToolTypes
  13. 3. CLI usage
  14. 4. History
  15. 5. Bugs
  16. 6. OriginalWare?
  17. 7. Also available...
  18. 8. Thanks to...
  19. 9. Credits
  20.  
  21. 1. Introduction
  22. ===============
  23.  
  24. HTMLess is just another utility to extract the text inside HTML files (Web
  25. pages) and convert it to a readable text format.In April'96 I released
  26. the first version, since them I received lot of EMails with bugs, ideas
  27. and support who keep me busy developing and improving HTMLess, I released
  28. 4 improved versions, today (23.Jul.96) another release is ready: v2.1,
  29. I hope this new version could fill the needs of everybody, my goal was a
  30. small, eficient, fast, easy to use and reliable program to convert WWW HTML
  31. pages to text files.I hope all you will find HTMLess useful.
  32.  
  33. The main features are:
  34.  
  35.  - Fast, written 100% in assembler. (Even faster since v1.2, and the fastest
  36.    with the new in v1.3 CLI option -w or the ToolType WINDOW disabled)
  37.  - Small but powerful utility (only 12000 bytes long).
  38.  - CLI and Workbench usage.
  39.  - ToolTypes support. [New since v2.0]
  40.  - Admit filenames as CLI parameters (can be launched from a
  41.    DiskMaster/DirOpus type program to autoconvert HTML's).
  42.  - All non-ASCII chars are converted.
  43.  - Output text could be formatted to easy reading.
  44.  - Can keep [href's] (like WWW adresses) in the output text.
  45.  - .HTML or .HTM filename suffix could be changed to your own defined text
  46.    extension. [New since v2.0]
  47.  - The program will report any kind of errors.
  48.  - Very easy to use...just try it.
  49.  - WYSIAWYG (WhatYouSawIsAlmostWhatYouGet)
  50.  - Great results (complex AI routines used *8).
  51.  - HTML Lists converted to text lists.
  52.  - `HTMLess' is a wonderful name. 
  53.  - No annoying requesters when starting/using/quitting program.
  54.  - It's OriginalWare (OriginalWhat?) and it's only Amiga (Yeah!).
  55.  
  56. The only requirement is the "ReqTools.library" by Nico Francois and Magnus
  57. Holmgren who fortunately is continuing the development of the indispensable
  58. reqtools library.
  59.  
  60. If you need a custom version of this program (for a personal necessity);
  61. contact me and I will try to make a customized version for you (if it isn't
  62. to difficult or too much work).
  63.  
  64. If you think the sources (100% assembler) could be useful for you (to include
  65. in a program you are developing or for learning purposes) just contact me and
  66. ask for them.
  67.  
  68.  
  69. 2. Workbench usage and ToolTypes
  70. ================================
  71.  
  72. 2.1 Workbench usage:
  73.  
  74. Just launch the program and use the file requester to select the HTML file to
  75. load and to choose the name to save the text file.
  76. (Since v1.1 this `complex' option works *8)
  77. [New since v1.2]
  78. The program will ask for another filename after saving the converted file,
  79. when you don't have more HTML files to convert, Cancel or Close the file
  80. requester to exit. (Use the icon ToolType SINGLE for just one use)
  81.  
  82. 2.2 ToolTypes [New since v2.0]
  83.  
  84. The ToolTypes of the icon will be used as default configuration.
  85. The ToolTypes are equivalent to the CLI options, but if used, all the CLI
  86. options will prevail over the ToolTypes options.
  87.  
  88. COLUMNS=x    Number of columns to format the text (x is a number, 0<x<9999)
  89.         (If x=0 the text will be `formated' like the original file)
  90. HTTP        Insert href's in the output text between "[...]" chars.
  91. WINDOW        Open a Workbench window to display info.This option is
  92.         incompatible with YAK commodity, if you use YAK disable this.
  93. SINGLE        Convert just one file and exit without asking for a new file.
  94. AUTOSAVE    Save the text without a file requester.
  95. OVERWRITE    Overwrite the original HTML file, so use with caution.
  96. EXTENSION=text  Add a text extension to the savename.
  97. PATH=Dir    Select the default start directory.
  98.  
  99. To disable options use brackets with the ToolType.
  100. Example : 
  101. WINDOW        Window enabled
  102. (WINDOW)    Window disabled
  103.  
  104.  
  105. 3. CLI usage
  106. ============
  107.  
  108. Just write the command `HTMLess' with your favourite options in any CLI/Shell
  109. window.
  110.  
  111.  `HTMLess [?] [-Cxxxx] [-H] [-W] [-S] [-A] [-O] [-E...] [-P] [filename/path]'
  112.  
  113. Write just the options or the options and the path or filename (if not
  114. filename is given or if there is any kind of problem a file requester
  115. will be used with your defined path).
  116. Options must be ahead of the file name and must be after a "-" char.
  117. Options can be together or alone (-c20h or -c -h20),  and written in capital
  118. or small letters (-HC5, -hc5 or -hC5)
  119. The -Etext option must be used separated from the others options (-hc5 -e.txt).
  120.  
  121. The available options are: 
  122.  -h     : if used "href's" will be removed.By default "href's" are included
  123.           in the output text between "[...]" chars.
  124.  -cXXXX : XXXX are 1 to 4 numbers (-c10,-c200,-c0080) to select the size of
  125.           the columns of the formated text (default size is 80 columns).
  126.       If the number is zero, text won't be formatted (-c0,-c0000)
  127. [New since v1.2]
  128.  ?, -? or -help : give CLI USAGE: info.
  129. [New since v1.3]
  130.  -w     : when used HTMLess window won't be opened.And the conversion will
  131.           be really faster; try it.Errors will be reported to the CLI
  132.           window, if it's opened.
  133.  -p     : you can define the path to your favourite HTML directory
  134.       Used without [path] is useless.
  135. [New since v2.0]
  136.  -s     : Single use, 
  137.  -a     : AutoSave, save without a requester asking for the filename. 
  138.  -o     : Overwrite, use with caution, will overwrite original file.
  139.  -e.TXT : Add a text extension to the original filename (you define the text).
  140.  
  141.  
  142. Examples:
  143.  
  144. 1. HTMLess -hc80 File1.html
  145.    Results : A text file "File1.text" without [href's] and formated to 80
  146.              columns will be saved.
  147.  
  148. 2. HTMLess -h -c0040 File2.htm
  149.    Results : A text file "File2.txt" without [href's] and formated to 40
  150.              columns will be saved.
  151.  
  152. 3. HTMLess -c0 File3.txt
  153.    Results : A text file with the same name "File3.txt" with [href's] and
  154.    unformated text will be saved.
  155.  
  156. 4. HTMLess -p RAM:Temp/HTML    (RAM:Temp/HTML is a path, not a file)
  157.    Results : File requester with the files in the directory: `RAM:Temp/HTML/...'
  158.  
  159. 5. HTMLess -e.Document File4.html
  160.    Results : A text file with the name "File4.Document"
  161.  
  162.  
  163. Common errors :
  164.  
  165. 1. Options must be after a "-" char always.
  166.    BAD: HTMLess -h c80 File1.html
  167.    OK : HTMLess -hc80 File1.html
  168.    OK : HTMLess -h -c80 File1.html
  169.  
  170. 2. Options must be ahead of the filename.
  171.    BAD: HTMLess File1.htm -c20h
  172.    OK : HTMLess -c20h File1.htm
  173.    
  174.  
  175. 4. History
  176. ==========
  177.  
  178. Version 1.0 ( 1.April.1996) :
  179.  - First official release.
  180.  
  181. Version 1.1 ( 5.April.1996) :
  182.  - Fixed Workbench icon bug (Sorry about that stupid icon type error).
  183.  - All non-ASCII chars are supported now. (Not really, try v1.2)
  184.  - Improved conversion of HTML Lists (now are more readable).
  185.  - Some extra Line Feeds are removed (but not all, to make readable a lot
  186.    of not-very-standard HTML Web pages)
  187.  - A rarely Guru bug with small files fixed.
  188.  - Last char of the text isn't deleted now.
  189.  
  190. Version 1.2 (12.April.1996) :
  191.  - Even more speed: a lot faster when Fast memory is available. (Test it)
  192.  - You can convert several files without reloading HTMLess.  (Otto von Ruggins)
  193.  - ">" by "}", and "<" by "{" bug removed.              (Markus Krajewski)
  194.  - CLI Usage info.                              (Alfredo Soro)
  195.  - All non-ASCII chars are supported now (I said the same in v1.1 *8)
  196.  - Some rare and little system-unfriendly bugs removed.
  197.  - Improved conversion for some HTML commands ( </P>, <DT> y <H....>)
  198.  - Spaces removed at the end of lines.
  199.  - More helpful people included in this doc (Look: 6.Thanks to... *8)
  200.  
  201. Version 1.3 (16.April.1996) :
  202.  - New CLI option. -w : no window will be opened and the conversion is FASTER.
  203.  - New CLI option. -p : will permit define your own path as default dir.
  204.  - Problem with YAK commodity detected, but not fixed yet.      (John Turgoose) 
  205.  - Even more helpful people included in this doc (Look: 8.Thanks to... *8)
  206.  
  207. Version 2.0 ( 1.May.1996) :
  208.  - Added Workbench icon ToolTypes support (All the CLI options have a ToolType)
  209.  - Almost all the duplicated text titles are removed now.
  210.  - Bug fixed: filesize limit of 64 KB removed.              (Markus Krajewski)
  211.  - Bug fixed: TABS (tabulator chars) are accepted.         (Markus Krajewski)
  212.  - New WB/CLI option. -A : AutoSave, no save-filename requester. 
  213.  - New WB/CLI option. -O : OverWrite original file! (Use with caution!)
  214.  - New WB/CLI option. -S : Single use, convert just one file and exit.
  215.  - New WB/CLI option. -E.text : Add a text extension to the filename. 
  216.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  217.  
  218. Version 2.1 (23.Jul.1996) :
  219.  - Lame Bug fixed: Now works without Fast RAM. (I.Gallego, G.A.Gomez & I.Sofke)
  220.  - Still even more helpful people included in this doc (Read: 8.Thanks to...*8)
  221.  
  222.  
  223. ToDo List:
  224.  - Fix all the bugs that will be discovered by users (Don't try so hard *8)
  225.  - Fix the strange YAK BUG listed in `5. Bugs'.
  226.  - Display improved formated LISTS.
  227.  - Display improved formated TABLES.
  228.  - Option to convert bold and italic tags as ANSI.
  229.  - Option to convert HTML to RTF text
  230.    (useful for a future use in a word processor)
  231.  
  232.  
  233. 5. Bugs
  234. =======
  235.  
  236. [New since v1.3]
  237. There is an unknown bug in some Amigas, looks like there is a compatibility
  238. problem with the YAK commodity (thanks to John Turgoose for this info).So
  239. try to disable/unload/stop/turn off YAK when using HTMLess.
  240. The problem is a warning Guru (yellow) each time you run HTMLess, after
  241. that you can't close the HTMLess window.Since v1.3 I included a new CLI option
  242. (-w), when used HTMLess don't open his own window, but will report errors
  243. to the CLI window, if it's open.As an added bonus with this option turned
  244. on the conversion is a lot faster.
  245.  
  246. There isn't anymore KNOWN bugs at the moment in all the Amigas tested but...
  247.  
  248. If you find any bug or problem, contact me at the previous address.Please,
  249. send me a detailed report of the problem and of your Amiga computer if
  250. possible; thanks.
  251.  
  252. If you found the problem with a particular file, send me too a copy of
  253. the file.
  254.  
  255. Don't forget to tell me the current version of my program you are using.
  256.  
  257.  
  258. 6. OriginalWare ?
  259. =================
  260.  
  261. This  utility  is OriginalWare.That means if you like this program you must
  262. buy  an  original Amiga program or game, or send the money to the author of
  263. any ShareWare program or game you are using often.
  264. (This includes me, $5 or $10 will be welcome *8)
  265.  
  266. There  are  lots  of  great Amiga software like `DiskMaster', `Remind',
  267. `MultiCX', `Spot', `ReqTools.library', `Deluxe Galaga', `APlayer' and a
  268. lot more that you won't never regret to spend your money.
  269.  
  270. If you do this you support the Amiga, and if you support AMIGA you support
  271. US.Support software authors and you will get more and better software.
  272.  
  273.  
  274. This program could be included in any PD compilation at a symbolic price.
  275.  
  276. Aminet and Fred Fish collections are specifically allowed to include it.
  277.  
  278. This program could be freely included in any Web page or FTP site, but
  279. send me an EMail to know it (I can include the address in this doc).
  280.  
  281. For using them in commercial products, my written permission is required.
  282. Inclusion in magazines and diskmags will be allowed, if you send me a copy of
  283. this publication.
  284.        
  285.  
  286. 7. Also available...
  287. ====================
  288.  
  289. Others quality Amiga PD products available from me :
  290.  
  291. Aminet recent uploads :
  292.  
  293. HTMLess.lha   v2.1   text/hyper     15K v2.1 Converts HTML files in text files.
  294. DKSound.lha   v2.2   util/boot   53K Changes Workbench Sounds at each boot.
  295. MagiCA64.lha  v1.1   misc/emu     6K Converts A64/64 files to MagiC64 format.  
  296. Progress.lha  v1.0   demo/intro  73K In Progress/Darkness.1st at Euskal Party
  297. Vectoram.lha  v1.3   dev/misc    15K Draw and edit 2D vectors for demos/games
  298. TheRace5.lha  v1.5   game/2play  59K Great 100m Running game, 0-4 players.
  299.  
  300. Available soon:
  301.  
  302. ELF.lha       v1.0   text/misc         Erase Line Feeds.Use for Word Procesors.
  303. FormaText.lha v1.0   text/misc         Format texts to your chosen columns size 
  304.  
  305. All them are 100% written in pure assembler for speed and are very system 
  306. friendly in all types of Amiga computers (or that is what I hope *8).
  307.  
  308.  
  309. 8. Thanks to...
  310. ===============
  311.  
  312. First a very special THANK to Jon B. Peterson from San Angelo (Texas, USA),
  313. for being the first (and only) ever person to send me some money for my work.
  314.  
  315. Alfredo Soro.es for the first ßeta testing.
  316. Otto Von Ruggins for the first bug report and some tests.
  317. Philippe Duchenne.be for reporting some bugs and interesting ideas.
  318. Markus Krajewski.de for lots of bugs and nice ideas.
  319. Geoff Milnes for another bug report.
  320. John Turgoose.ca for the problem with the YAK commodity.
  321. Jerome Chesnot.fr for EMail support, even "TheRace" support. (R.A.M. is great!)
  322. David Cassidy.uk for don't forget me *8) .
  323. Jose Vergara.es for Fido EMail support.
  324. Andrew Bruno.au for EMail support. 
  325. Mikael Osterhed.it for EMail support.
  326. Glenn Zieman for EMail support and suggestions.
  327. Joerg Plate.de for EMail suggestions.
  328. Derik Pyper.ca for nice EMail support.
  329. Adriano Altorio.it for EMail support.
  330. David de Groot.be for nice EMail support.
  331. Dareen Enns for EMail suggestions.
  332. Peter Soderber.se for EMail support.
  333. Ignacio Gallego.es for the Fast RAM bug.
  334. Gustavo Adolfo Gomez.ve for the Fast RAM bug and nice EMail..
  335. Ivan Sofic.yu for the Fast RAM bug report.
  336.  
  337. Hipnooxis.es for ALL the help and show me to use and respect the Amiga O.S.
  338.  
  339. Knackosoft.de/TRSI for being my best `invisible' friend.
  340.  
  341. To the `Atletico de Madrid', the best football team in Spain.
  342.  
  343. To all the Amiga developers for all the new, fun and useful stuff.
  344.  
  345. To all the Amiga users (you!) worldwide for their trust in the Amiga.
  346.  
  347. To Amiga Technologies for continue the development of the Amiga...for a while.
  348.  
  349. To VIScorp for continue the development of the Amiga
  350.  
  351. To the Amiga...
  352.  
  353.  
  354. 9. Credits
  355. ==========
  356.  
  357. All code © 1996 by Troglobyte/Darkness.
  358.  
  359. Send money ($), JOB offers, BUGS, comments, improvements, ideas, advices,
  360. suggestions, mags, complains, and nice  PD  stuff  (like Demos, Games or
  361. Utilities).
  362.  
  363.             M. Martin Vivaldi
  364.              Av. America 60
  365.               Madrid 28028
  366.                  SPAIN
  367.  
  368. Or NetMail me at :
  369.  
  370.  Internet : bitabit@servicom.es (Faster and safer)
  371.  
  372.  FidoNet  : 2:341/28.55        Manuel Martin
  373.  
  374.  AmigaNet : 39:192/1.29        Manuel Martin
  375.  
  376.  
  377. Remember:
  378.  
  379.       Only Amiga make it possible... Only Amiga make it fun.
  380.  
  381.  
  382.